
<!DOCTYPE html>

<html xmlns="http://www.w3.org/1999/xhtml">
  <head>
    <meta charset="utf-8" />
    <title>ambient.get_world_ocean &#8212; Texas A&amp;M Oil spill / Outfall Calculator 2.1.0 documentation</title>
    <link rel="stylesheet" href="../../_static/alabaster.css" type="text/css" />
    <link rel="stylesheet" href="../../_static/pygments.css" type="text/css" />
    <script id="documentation_options" data-url_root="../../" src="../../_static/documentation_options.js"></script>
    <script src="../../_static/jquery.js"></script>
    <script src="../../_static/underscore.js"></script>
    <script src="../../_static/doctools.js"></script>
    <script src="../../_static/language_data.js"></script>
    <link rel="index" title="Index" href="../../genindex.html" />
    <link rel="search" title="Search" href="../../search.html" />
    <link rel="next" title="ambient.load_raw" href="ambient.load_raw.html" />
    <link rel="prev" title="ambient.add_data" href="ambient.add_data.html" />
   
  <link rel="stylesheet" href="../../_static/custom.css" type="text/css" />
  
  
  <meta name="viewport" content="width=device-width, initial-scale=0.9, maximum-scale=0.9" />

  </head><body>
  

    <div class="document">
      <div class="documentwrapper">
        <div class="bodywrapper">
          

          <div class="body" role="main">
            
  <div class="section" id="ambient-get-world-ocean">
<h1>ambient.get_world_ocean<a class="headerlink" href="#ambient-get-world-ocean" title="Permalink to this headline">¶</a></h1>
<dl class="function">
<dt id="ambient.get_world_ocean">
<code class="sig-prename descclassname">ambient.</code><code class="sig-name descname">get_world_ocean</code><span class="sig-paren">(</span><em class="sig-param">Ts=290.41</em>, <em class="sig-param">Ss=34.89</em><span class="sig-paren">)</span><a class="reference internal" href="../../_modules/ambient.html#get_world_ocean"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#ambient.get_world_ocean" title="Permalink to this definition">¶</a></dt>
<dd><p>Load the world ocean average CTD data</p>
<p>Load the world ocean average temperature, salinity, and oxygen profile
data from Levitus et al. (1998) as reported on Page 226 of Sarmiento and
Gruber (2006), “Ocean Biogeochemical Dynamics.” If surface ocean
properties of temperature and salinity are known, then scale the profile
to match these properties.</p>
<dl class="field-list simple">
<dt class="field-odd">Parameters</dt>
<dd class="field-odd"><dl class="simple">
<dt><strong>Ts</strong><span class="classifier">float, default=290.41</span></dt><dd><p>Temperature of the ocean surface (K)</p>
</dd>
<dt><strong>Ss</strong><span class="classifier">float, default=34.89</span></dt><dd><p>Salinity of the ocean surface (psu)</p>
</dd>
</dl>
</dd>
<dt class="field-even">Returns</dt>
<dd class="field-even"><dl class="simple">
<dt><strong>data</strong><span class="classifier">ndarray</span></dt><dd><p>Array containing the profile data organized with depth in the 
first column, temperature, salinity and pressure in the next three
columns and any chemical concentration data in the remaining 
columns.</p>
</dd>
<dt><strong>ztsp</strong><span class="classifier">str list</span></dt><dd><p>String list containing the variables names for depth, temperature, 
salinity, and pressure that are to be used in the Profile data.</p>
</dd>
<dt><strong>ztsp_units</strong><span class="classifier">str list</span></dt><dd><p>String list containing the units for depth, temperature, salinity, 
and pressure.</p>
</dd>
<dt><strong>chem_names</strong><span class="classifier">str list</span></dt><dd><p>Names of the chemicals (e.g., those constituents in addition to z, T,
S, P) in the dataset that should be accessible through the
<cite>self.get_values</cite> interpolation method or the <cite>self.get_units</cite>
interrogator of the <cite>Profile</cite> object.</p>
</dd>
<dt><strong>chem_units</strong><span class="classifier">str list</span></dt><dd><p>Names of the units for each constituent in the <cite>chem_names</cite> variable</p>
</dd>
</dl>
</dd>
</dl>
</dd></dl>

</div>


          </div>
          
        </div>
      </div>
      <div class="sphinxsidebar" role="navigation" aria-label="main navigation">
        <div class="sphinxsidebarwrapper">
<h1 class="logo"><a href="../../index.html">Texas A&M Oil spill / Outfall Calculator</a></h1>








<h3>Navigation</h3>
<ul class="current">
<li class="toctree-l1 current"><a class="reference internal" href="../../user_manual.html">TAMOC User Manual</a></li>
<li class="toctree-l1"><a class="reference internal" href="../../unit_tests.html">Unit Tests</a></li>
<li class="toctree-l1"><a class="reference internal" href="../../glossary.html">Glossary</a></li>
</ul>
<ul>
<li class="toctree-l1"><a class="reference internal" href="../../bugs.html">Reporting Bugs</a></li>
<li class="toctree-l1"><a class="reference internal" href="../../readme.html">Read Me File</a></li>
<li class="toctree-l1"><a class="reference internal" href="../../release.html">Release Notes</a></li>
<li class="toctree-l1"><a class="reference internal" href="../../license.html">License</a></li>
</ul>

<div class="relations">
<h3>Related Topics</h3>
<ul>
  <li><a href="../../index.html">Documentation overview</a><ul>
  <li><a href="../../user_manual.html">TAMOC User Manual</a><ul>
  <li><a href="../../modules/ambient.html">Overview of Ambient Module</a><ul>
      <li>Previous: <a href="ambient.add_data.html" title="previous chapter">ambient.add_data</a></li>
      <li>Next: <a href="ambient.load_raw.html" title="next chapter">ambient.load_raw</a></li>
  </ul></li>
  </ul></li>
  </ul></li>
</ul>
</div>
<div id="searchbox" style="display: none" role="search">
  <h3 id="searchlabel">Quick search</h3>
    <div class="searchformwrapper">
    <form class="search" action="../../search.html" method="get">
      <input type="text" name="q" aria-labelledby="searchlabel" />
      <input type="submit" value="Go" />
    </form>
    </div>
</div>
<script>$('#searchbox').show(0);</script>








        </div>
      </div>
      <div class="clearer"></div>
    </div>
    <div class="footer">
      &copy;2020, Scott A. Socolofsky.
      
      |
      Powered by <a href="http://sphinx-doc.org/">Sphinx 2.4.4</a>
      &amp; <a href="https://github.com/bitprophet/alabaster">Alabaster 0.7.12</a>
      
      |
      <a href="../../_sources/autodoc/ambient/ambient.get_world_ocean.rst.txt"
          rel="nofollow">Page source</a>
    </div>

    

    
  </body>
</html>